Skip to main content

SDXL

The SDXL text-to-image diffusion model is capable of generating photo-realistic images from text descriptions. It is a deep learning model that was trained on a massive dataset of images and text captions. The model learns to associate the text with the corresponding images, and it can then use this knowledge to generate new images from text descriptions.


import requests
import json
url = "https://api.imagepipeline.io/sdxl/text2image/v1"
headers = {
"API-Key": "Your API Key"
}
data = {
"model_id": "d961a274-658c-4889-8c1a-bf85416cb1c1",
"prompt": "woman wearing traditional Russian clothes, forest in the background, photorealistic, 8k quality",
"negative_prompt": "error, cropped, worst quality, low quality, duplicate, bad proportions, incomplete subject",
"num_inference_steps": 30,
"refiner": true,
"samples": 1,
"guidance_scale": 7.5,
"width": 768,
"height": 768,
"safety_checker": true,
"scheduler": "UniPCMultistepScheduler",
seed: 12345
}
response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())

JSON Parameters

ParameterPermissible valuesNotes
model_idstrmodel_id can be found in models page. Filter by SDXL models
promptstr, 75 tokensCheck our Prompt Guide for tips
negative_promptstr, 75 tokensCheck our Prompt Guide for tips
num_inference_stepsint, [1-100]Noise is removed with each step, resulting in a higher-quality image over time. Ideal value 20-30
strengthfloat, [0-1]Optional denoise strength
samplesint, [1-4]Generates a maximum of 4 samples per API call
guidance_scalefloat, [1-20]Higher guidance scale prioritizes text prompt relevance but sacrifices image quality. Ideal value 7.5-12.5
widthintWidth in pixels. Lower than or equal to 768 for best results
heightintHeight in pixels. Lower than or equal to 768 for best results
seedintControlling the seed can help you generate reproducible images
safety_checkerbooleanChecks for NSFW images and filters explicit images

Status

Your response will include a status.

  • If the status = SUCCESS, you will also have download_urls that will have the links to your generated image based on the number of samples you have entered. The maximum number of samples that can be generated is 4.
  • If the status = PENDING, you will receive a id. You can use the status endpoint to fetch your image using the id.
  • If the status = FAILURE, you will receive only an error message.

Endpoint:

  • https://api.imagepipeline.io/sdxl/text2image/v1/status/{{id}}

Pass the API-Key as the authorization in the header.